home *** CD-ROM | disk | FTP | other *** search
/ Aminet 28 / Aminet 28 (1998)(GTI - Schatztruhe)[!][Dec 1998].iso / Aminet / dev / misc / vahunz.readme < prev   
Encoding:
Text File  |  1998-10-31  |  7.2 KB  |  194 lines
  1. Short:    Make source code un-/more legible
  2. Author:   Thomas Aglassinger <agi@giga.or.at>
  3. Uploader: Thomas Aglassinger <agi@giga.or.at>
  4. Version:  1.5
  5. Type:     dev/misc
  6. Requires: AmigaOS 2.04, 68020, 2MB
  7. Kurz:     Macht Quellcode un-/besser lesbar
  8.  
  9. TITLE
  10.  
  11.   vahunz - Make source code un-/more legible.
  12.  
  13. VERSION 
  14.  
  15.   1.5
  16.  
  17. AUTHOR
  18.  
  19.   Thomas Aglassinger <agi@giga.or.at>
  20.  
  21. DESCRIPTION
  22.  
  23.   Vahunz is a CLI-based replace command that can replace many words
  24.   across several files with only one invocation.
  25.  
  26.   Normally the target words will be created randomly, turning
  27.   meaningful names into unlegible garbage. For example, a function
  28.   name like read_input_file() could be replaced by g7B() or something
  29.   as useless. Additionally, comments and indention can be removed.
  30.  
  31.   As an option, you can specify specific substitutes, so Vahunz can
  32.   also be applied in a non-destructive manner. This can be used to
  33.   replace inconsistent, too short or unlegible names by something more
  34.   meaningful. Among programmers, this process is known as "The Great
  35.   Renaming".
  36.  
  37.   An Amiga Installer script acting as frontend to the CLI command is
  38.   included, so most tasks can be performed without dealing with those
  39.   cryptic command line options.
  40.  
  41. FEATURES
  42.  
  43.   - Stores less/more legible copy in a different directory
  44.   - Supports C, C++ and Java
  45.   - Auto-detects programming language
  46.   - New names since last run are easy to see
  47.   - Names can easily be declared to be modified or left untouched;
  48.     for example, it makes no sense to replace printf().
  49.   - Words being part of comments or string constants are not replaced
  50.   - Fast, as internally names are stored in an AVL-tree
  51.   - Several options to back-trace problems in vahunzed code
  52.   - Includes a set of standard dictionaries for various environments
  53.   - Includes source code (vahunzed ANSI C)
  54.  
  55. NEW FEATURES
  56.  
  57.   - Added full support for Java (keywords and dignorary)
  58.   - Vahunz-Tschak can now create dignoraries (Good bye, CLI!)
  59.   - Fixed bug in linker options; no more ixemul.library required.
  60.  
  61. SPECIAL REQUIREMENTS
  62.  
  63.   AmigaOS 2.04, 2MB of regular memory, 68020
  64.  
  65. AVAILABILITY
  66.  
  67.   - Every Aminet-mirror, file "dev/misc/vahunz.lha", for example:
  68.  
  69.     ftp://wuarchive.wustl.edu/pub/aminet/dev/misc/vahunz.lha
  70.  
  71.   - http://www.giga.or.at/~agi/vahunz/
  72.  
  73. PRICE
  74.  
  75.   Freeware.
  76.  
  77. DISTRIBUTABILITY
  78.  
  79.   Freely distributable as long the conditions described in the manual
  80.   are met.
  81.  
  82. EXAMPLE
  83.  
  84.   For example, one might have a code excerpt like this:
  85.  
  86.     int main(void)
  87.     {
  88.         while (sepp_age < 83)
  89.         {
  90.             grow_older(sepp_name, &sepp_age);
  91.             print_sepp();
  92.         }
  93.         printf("\n%s died.\n", sepp_name);
  94.         exit(EXIT_SUCCESS);
  95.     }
  96.  
  97.   After vahunzing, this is what it might look like:
  98.  
  99.     int main(void)
  100.     {
  101.     while (g8B < 83)
  102.     {
  103.     z3V(v6Z, &g8B);
  104.     f4V();
  105.     }
  106.     printf("\n%s died.\n", v6Z);
  107.     exit(EXIT_SUCCESS);
  108.     }
  109.  
  110.   As you can see, the internal names have been garbled, but the
  111.   symbols of the standard library are preserved.
  112.  
  113.  
  114. ============================= Archive contents =============================
  115.  
  116. Original  Packed Ratio    Date     Time    Name
  117. -------- ------- ----- --------- --------  -------------
  118.      628     277 55.8% 06-Sep-98 16:34:50  vahunz.info
  119.   208854   69468 66.7% 17-Sep-98 14:42:12 +amiga.ignore
  120.     5325    2313 56.5% 17-Sep-98 14:41:48 +ansi.ignore
  121.        1       1  0.0% 04-Sep-98 13:09:34 +empty.ignore
  122.    43094   14545 66.2% 16-Sep-98 16:15:08 +java.ignore
  123.   187597   65700 64.9% 17-Sep-98 14:42:32 +unix.ignore
  124.      204     116 43.1% 09-Feb-98 08:37:14 +Makefile
  125.      367     236 35.6% 09-Feb-98 08:38:44 +older.c
  126.      165     118 28.4% 09-Feb-98 08:34:48 +older.h
  127.      781     413 47.1% 14-Feb-98 20:13:40 +sepp.c
  128.      628     277 55.8% 06-Sep-98 16:34:42 +manual.info
  129.     5775    2600 54.9% 17-Sep-98 02:29:10 +beyond.html
  130.     6490    2679 58.7% 17-Sep-98 14:33:20 +dictionary.html
  131.     6737    2735 59.4% 17-Sep-98 16:23:00 +future.html
  132.      138     138  0.0% 14-Jan-96 17:27:46 +back.gif
  133.      190     190  0.0% 14-Jan-96 17:20:08 +copy.gif
  134.      170     170  0.0% 14-Jan-96 17:14:34 +index.gif
  135.      176     176  0.0% 14-Jan-96 17:14:44 +main.gif
  136.      189     189  0.0% 14-Jan-96 17:15:02 +next.gif
  137.      168     168  0.0% 14-Jan-96 17:28:12 +noback.gif
  138.      211     211  0.0% 14-Jan-96 17:20:36 +nocopy.gif
  139.      200     200  0.0% 14-Jan-96 17:15:28 +noindex.gif
  140.      201     201  0.0% 11-Jan-98 16:39:54 +nomain.gif
  141.      212     212  0.0% 14-Jan-96 17:15:52 +nonext.gif
  142.      213     213  0.0% 15-Jul-96 23:44:28 +noprev.gif
  143.      188     188  0.0% 14-Jan-96 17:16:08 +prev.gif
  144.      141     141  0.0% 04-Nov-95 02:20:36 +up.gif
  145.      981     981  0.0% 21-Feb-98 01:00:48 +vahunz-now.gif
  146.     1553    1553  0.0% 19-Apr-98 18:40:04 +vahunz.gif
  147.     4472    1897 57.5% 17-Sep-98 02:27:52 +index.html
  148.      481     256 46.7% 06-Sep-98 16:34:38 +index.html.info
  149.     5867    2545 56.6% 17-Sep-98 02:29:06 +inside.html
  150.     2592    1164 55.0% 17-Sep-98 02:29:02 +keyctionary.html
  151.     3484    1676 51.8% 17-Sep-98 02:28:16 +legal.html
  152.     5432    2397 55.8% 17-Sep-98 02:28:12 +overview.html
  153.     3552    1724 51.4% 17-Sep-98 02:28:22 +problems.html
  154.    12197    4749 61.0% 17-Sep-98 02:28:02 +reference.html
  155.     1534     750 51.1% 17-Sep-98 14:18:34 +requirements.html
  156.     2945    1383 53.0% 17-Sep-98 02:29:12 +source.html
  157.     2276    1068 53.0% 17-Sep-98 02:28:18 +support.html
  158.     2431    1166 52.0% 17-Sep-98 14:18:40 +tschak.html
  159.    10868    4336 60.1% 17-Sep-98 02:28:06 +tutorial.html
  160.     2056     964 53.1% 17-Sep-98 02:28:34 +use-case-1.html
  161.     4923    2071 57.9% 17-Sep-98 02:28:38 +use-case-2.html
  162.     2913    1349 53.6% 17-Sep-98 02:28:42 +use-case-3.html
  163.     3469    1687 51.3% 17-Sep-98 02:28:46 +use-case-4.html
  164.     3007    1400 53.4% 17-Sep-98 02:28:54 +use-case-5.html
  165.     2734    1255 54.0% 17-Sep-98 02:28:58 +use-case-6.html
  166.     1195     343 71.2% 19-Apr-98 16:08:14 +compile
  167.    25256    9275 63.2% 24-Oct-97 04:36:18 +COPYING.LIB
  168.     5677    1758 69.0% 17-Sep-98 16:24:12 +ubi_AVLtree.c
  169.     1981     858 56.6% 17-Sep-98 16:24:12 +ubi_AVLtree.h
  170.     6382    2291 64.1% 17-Sep-98 16:24:14 +ubi_BinTree.c
  171.     3152    1302 58.6% 17-Sep-98 16:24:14 +ubi_BinTree.h
  172.     6923    2058 70.2% 17-Sep-98 16:24:16 +expstr.c
  173.     2562     919 64.1% 17-Sep-98 16:24:16 +expstr.h
  174.     1105     495 55.2% 17-Sep-98 16:24:18 +udebug.h
  175.     8107    2883 64.4% 17-Sep-98 16:24:18 +umemory.c
  176.     2325     883 62.0% 17-Sep-98 16:24:20 +umemory.h
  177.     3414    1400 58.9% 17-Sep-98 16:24:20 +ustring.c
  178.     1606     712 55.6% 17-Sep-98 16:24:22 +ustring.h
  179.     1953     771 60.5% 17-Sep-98 16:24:22 +utypes.h
  180.     1926     814 57.7% 17-Sep-98 16:24:22 +keywords.c
  181.    24966    8635 65.4% 17-Sep-98 16:24:24 +vahunz.c
  182.     1046     497 52.4% 17-Sep-98 16:24:26 +vahunz_rev.h
  183.     3860    2448 36.5% 16-Sep-98 03:33:02 +blank-to-hyphen
  184.      466     253 45.7% 16-Sep-98 03:32:52 +blank-to-hyphen.c
  185.      886     397 55.1% 02-Sep-98 08:08:24 +def_vahunz.info
  186.     1463     631 56.8% 16-Sep-98 03:14:32 +scan-javadoc.rexx
  187.    40928   23508 42.5% 17-Sep-98 14:43:18 +vahunz
  188.    32451    7526 76.8% 17-Sep-98 14:30:24 +Vahunz-Tschak
  189.      930     430 53.7% 16-Sep-98 03:18:08 +Vahunz-Tschak.info
  190.     2762    1456 47.2% 17-Sep-98 16:23:58 +vahunz.readme
  191.      496     267 46.1% 04-Sep-98 13:29:12 +vahunz.readme.info
  192. -------- ------- ----- --------- --------
  193.   732628  273056 62.7% 17-Sep-98 22:32:26   74 files
  194.